home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / rombrain.zip / ROMBRAIN.DOC < prev    next >
Text File  |  1991-12-13  |  14KB  |  348 lines
  1. December 13, 1991
  2.                                                                      1.
  3.  
  4.  
  5.  
  6.  
  7.                                   ROMBRAIN
  8.                       (C) Copyright 1991 by Stanley Sheff
  9.                         Support BBS: The Brainex System
  10.                                (310) 275-2344
  11.                                (310) 273-5234
  12.                  A CDROM File Door for any BBS using any CD.
  13.                  -------------------------------------------
  14.  
  15.    Welcome to the RomBrain. Now your callers can access your CDROM drive
  16.    without having to use your BBS's file system.  This door works with
  17.    GAP, PCBoard, Wildcat, Spitfire, WWIV, and RBBS, as well as any BBS that
  18.    generates a DOOR.SYS file when running a door.  RomBrain is a multi-user
  19.    door and requires SHARE.EXE and DOS 3.3 or  above.  RomBrain WILL NOT WORK
  20.    on versions of GAP below 5.  RomBrain will NOT check download limits on
  21.    nonGAP BBSes.
  22.    
  23.    RomBrain requires the program DSZ.COM or DSZ.EXE in the path.
  24.    If you have an unregistered DSZ, Y-Modem G protocol will NOT function.
  25.    
  26.    Some older DOOR.SYS conversion programs may generate an ERROR 62.
  27.    You will need to use a newer version of DOOR.SYS if this problem
  28.    occurs...
  29.  
  30.    Here's what the RomBrain can do:
  31.  
  32.    Supports IBM ANSI Color and plain text mode (ASCII) 
  33.    for your callers who don't use IBM characters or don't use ANSI.
  34.    
  35.    RomBrain supports com ports opened up to 38400 and as 
  36.    many of them as you can fit in the machine. This makes RomBrain easy 
  37.    to set up on a multi-node system with GAP. RomBrain will also 
  38.    support several other BBSes by the use of conversion programs available 
  39.    nearly everywhere.
  40.     
  41.    RomBrain creates an index file from information stored on your CD.
  42.    The file uses about 600K of disk space.   
  43.  
  44.    Menu Functions:
  45.  
  46.    [F]ile Directory
  47.    Allows you to select one of the CD ROM directories.  Once you've 
  48.    selected a directory, you may:
  49.  
  50.    [D]ownload file(s)
  51.    You can add names to a list of files for download.  The list
  52.    may be edited.  If you use Xmodem Protocol, each file will
  53.    be sent one at a time, and you will be asked if you wish to
  54.    continue receiving files from the list.
  55.  
  56.    [M]ark a file 
  57.    Add the file name entered to a list to be downloaded later.
  58.    Just type the letter shown to the left of the filename. 
  59.  
  60.                                                                      2.
  61.  
  62.  
  63.  
  64.    [A]rchive
  65.    View contents of a .ZIP file, Read a file from within the .ZIP file,
  66.    Transfer (Download) a file from within the .ZIP file, or Download 
  67.    the entire .ZIP file.
  68.  
  69.    [S]earch for text within the directory.  You may enter all or any
  70.    part of a word for a search.  This function searches filename, date,
  71.    and description. Selected word will be highlighted in red for color
  72.    or <brackets> for monochrome.
  73.  
  74.    The above commands are available from the Main Menu as well as the
  75.    Directory Menu.
  76.  
  77.   *NOTE: When asked to enter a file name, .ZIP will be added automatically
  78.          if you do not include an extender.  
  79.  
  80.  
  81.     RomBrain Files
  82.     ----------------
  83.     ROMBRAIN.EXE <------------------ RomBrain Program
  84.     ROMBRAIN.DOC <------------------ Sysop's Information
  85.     CDBRAIN.CNF  <------------------ Sample Configuration File
  86.     REGISTER.DOC <------------------ Registration information
  87.     SETUP.EXE    <------------------ Setup / Initializer Program
  88.     HELP         <------------------ General Help File
  89.     CDHELP       <------------------ Download Help File
  90.     WELCOME      <------------------ ASCII Welcome Screen     
  91.     WELCOMEG     <------------------ ANSI Welcome Screen
  92.     DOOR.SYS     <------------------ Sample DOOR.SYS file
  93.     EXTSX.BAT    <------------------ Batch File to call DSZ Xmodem
  94.     EXTS1.BAT    <------------------ Batch File to call DSZ Xmodem/1K
  95.     EXTSY.BAT    <------------------ Batch File to call DSZ Ymodem
  96.     EXTSZ.BAT    <------------------ Batch File to call DSZ Zmodem
  97.     EXTSF.BAT    <------------------ Batch File to call DSZ Xmodem/1K-G
  98.     EXTSG.BAT    <------------------ Batch File to call DSZ Ymodem-G
  99.  
  100.    All of these files should be in this ZIP, if they are not, don't
  101.    take a chance! Call The Brainex System and get a good copy or view the 
  102.    file on a few local boards to see if you can find a complete copy.
  103.  
  104.    The setup of RomBrain is simple, all you need to do is create a
  105.    directory for RomBrain and its files then copy the files into that
  106.    directory. After that you will need to create a config file with 
  107.    the following information and place it in that directory.
  108.  
  109.  
  110.                                                                      3.
  111.  
  112.  
  113.     
  114.     (sample CDBRAIN.CNF)
  115.  
  116.    C:\GAP
  117.    The Brainex System
  118.    GAP
  119.    0000000
  120.    E:
  121.    50
  122.    C:\CDROM
  123.    A
  124.    X1YZFG
  125.    Sorry! Downloads Restricted to Level 50
  126.    ===================================================================
  127.    (You do not need to remove these comments, RomBrain reads only the
  128.    first 9 lines of this file...)
  129.    ===================================================================
  130.    Line 1    Path to DOOR.SYS, DORINFO1.DEF, CHAIN.TXT, or SFDOORS.DAT
  131.    Line 2    BBS Name
  132.    Line 3    BBS Type: GAP (DOOR.SYS/GAP ONLY!)     SF   (Spitfire/SFDOORS.DAT)
  133.                        WC3 (Wildcat 3/DOOR.SYS)     WWIV (CHAIN.TXT)
  134.                        PCB (PCBOARD 14/DOOR.SYS)    RBBS (DORINFO1.DEF)
  135.                        GEN (Generic DOOR.SYS/All Other BBSes)
  136.    Line 4    Registration Number
  137.    Line 5    CD ROM Drive Device ID
  138.    Line 6    Access Level for Downloads
  139.    Line 7    Path to CDTYPE_x.x and CD_DATA Files
  140.    Line 8    CD Type  A=CARRS B=GRAB BAG C=RBBS IN-A-BOX D=CUSTOM
  141.    Line 9    Transfer Protocols:
  142.                X=Xmodem
  143.                1=Xmodem/1K
  144.                Y=Ymodem Batch
  145.                Z=Zmodem
  146.                J=Jmodem
  147.                G=Ymodem-G (MNP)
  148.                F=Xmodem/1K-G (MNP)
  149.    Line 10   Restricted Downloads Message
  150.    ============================================================================
  151.  
  152.    Note:  If using GAP and you do not want to update user stats,
  153.           Just set line 8 to PCB, and RomBrain will NOT write
  154.           any data to the users.dat file or caller logs.
  155.  
  156.   RomBrain will NOT check for download file limits on non GAP BBSes. 
  157.  
  158.   Indicate on line 9 the types of file transfer protocols you
  159.   can support.
  160.  
  161.   RomBrain handles all of its file transfers from within the door.
  162.   The sysop may define which protocols to use. A set of predefined
  163.   protocol batch files are included for use with the DSZ protocol engine.
  164.  
  165.  
  166.                                                                      4.
  167.  
  168.  
  169.  
  170.   Parameters are passed to the protocol batch files in the following order:
  171.    
  172.         %1 - Communications port
  173.         %2 - Baud rate
  174.         %3 - File name to send
  175.  
  176.  
  177.    SETUP
  178.    =====
  179.    
  180.    Use SETUP.EXE to initialize RomBrain.  SETUP.EXE requires the sample
  181.    DOOR.SYS to be placed in the same directory as SETUP.EXE.
  182.    Before you use SETUP, it's a good idea to know the contents of
  183.    your CD.  Make a note of the location of the text files that
  184.    describe the directories of your CD, and their names.
  185.  
  186.    For most CDs, use the AUTOMATIC SETUP option.  If you like, you may
  187.    edit the file CDTYPE_x.4 to customize category names. The "x" will
  188.    be substituted for CD type. Ex. CDTYPE_A.4 is for type A, CARRS CD.
  189.  
  190.    For Multi-Node systems, SETUP will create a WORK directory for each
  191.    node (WORK1, WORK2, etc.)
  192.  
  193.    The setup program will create the following files:
  194.  
  195.    CDTYPE_x.1
  196.    CDTYPE_x.2
  197.    CDTYPE_x.3
  198.    CDTYPE_x.4  (ASCII file of category names.  Edit this for accuracy!)
  199.  
  200.    The file directory menu is generated internally by the RomBrain,
  201.    but if you wish to use a customized menu, just create your menu
  202.    and name it MENUx for ASCII and MENUxG for ANSI.  "x" stands for
  203.    the CD Type (MENUA=CARRS, etc.). Place the MENUx files in
  204.    the same directory as RomBrain.
  205.  
  206.    If you use more than one CD drive, you can use the SETUP to create
  207.    a set of data files for each.  Example:
  208.  
  209.    CARRS CD would have these files:
  210.  
  211.    CDTYPE_A.1    CDTYPE_A.2    CDTYPE_A.3   CDTYPE_A.4
  212.  
  213.    RBBS IN A BOX would have these:
  214.  
  215.    CDTYPE_C.1    CDTYPE_C.2    CDTYPE_C.3   CDTYPE_C.4 
  216.  
  217.                                                                      5.
  218.  
  219.    Make a directory for each set of cdtype files, then copy the files into
  220.    the directory.
  221.  
  222.    Edit the sample DRIVE.DAT file to match your set up. The format for this
  223.    file is: CD VOLUME NAME,CDTYPE CODE,CD DRIVE LETTER,PATH TO CDTYPE FILES
  224.    There should be a line of information for each CD.
  225.  
  226.    Example DRIVE.DAT file:
  227.  
  228.             CARRS #4,A,D:,C:\CDROM\CARRS4
  229.             CARRS #5,A,E:,C:\CDROM\CARRS5
  230.             RBBS IN A BOX,C,F:,C:\CDROM\RBBS
  231.  
  232.    Note: Use the comma to separate the information. If you use a comma
  233.          within the information like: CARRS, #4  errors will occur.
  234.          Include a colon with drive letter (Example E:).
  235.  
  236.    Once you have created your config file, you must then create a a batch 
  237.    file to call the door. A batch file for a GAP BBS might look like this:
  238.    
  239.      ECHO OFF
  240.      SET DSZLOG=LOGx     <-------(Required for DSZ  x=Node Number)
  241.      CD \DOORS\ROMBRAIN   
  242.      ROMBRAIN CDBRAIN.CNF
  243.      CD \GAP
  244.  
  245.    It is recommended but not required that you call RomBrain with the
  246.    config file's name on the command line. If you don't, RomBrain will
  247.    simply default to CDBRAIN.CNF.
  248.  
  249.    You will also need to modify your doors menu files and the data
  250.    file that tells the BBS what your doors are and the security
  251.    level needed to access them. For GAP, these are respectively:
  252.    
  253.        DOORM
  254.        DOORMG
  255.        DOORS.DAT
  256.  
  257.    Please refer to your BBS documentation for details on 
  258.    setting up these files.
  259.  
  260.    If you are running multi-nodes, simply create a separate door
  261.    configuration file for each node, and number them. For instance,
  262.    for a 3 node system, you might have the following configuration
  263.    files:
  264.  
  265.        CDBRAIN1.CNF
  266.        CDBRAIN2.CNF
  267.        CDBRAIN3.CNF
  268.  
  269.                                                                     6.
  270.  
  271.    The only difference between the three would be the 1st line which
  272.    points to the default directory for the particular node.
  273.  
  274.    Another easy way to add the RomBrain to GAP is to use Gap's
  275.    configuration option to create a SYSOP DEFINED COMMAND (consult Gap's 
  276.    docs for info on sysop defined commands). On The Brainex System I use 
  277.    CDROM. The batch file to run RomBrain is named CDROM.BAT and placed 
  278.    in the BBS default directory (C:\GAP). When a caller types CDROM at the 
  279.    main prompt, they are instantly taken to the RomBrain.
  280.  
  281.    The following files are read during door initialization. They
  282.    must be present or the door will not operate.
  283.                                 
  284.        DOOR.SYS (or DORINFO1.DEF, CHAIN.TXT, SFDOORS.DAT)
  285.        GAPBBS.CNF  (GAP BBS only)
  286.        USERS       (GAP BBS only)
  287.                                     
  288.    The following sysop functions are available while awaiting
  289.    keyboard input :
  290.  
  291.      F5      - Shell to DOS.
  292.      F8      - Twit user and return to BBS.
  293.     F10      - Initiate chat with user.
  294.     CF10     - Answer user page bell.
  295.     Home     - Main user stats.
  296.     End      - Displays sysop keys available.
  297.     PgDn     - Secondary user stats.
  298.     Up Arrow - Increase user's time remaining by 5 minutes.
  299.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  300.  
  301.    One of the nicer features about using the TWIT key, is the user
  302.    is not told that "the sysop wants them to return to the BBS".
  303.    Instead, a very plain and simple message of "returning you to the
  304.    BBS" is displayed.  This way, the user is given no indication
  305.    that the sysop is hovering about.
  306.  
  307.    When using the F5 shell to DOS key, to return to the door
  308.    program, simply type EXIT at the DOS command prompt. It is not
  309.    necessary to change directories back to the door directory.
  310.    RomBrain is smart enough to know which drive and directory the
  311.    door program is in and will reset the defaults upon return from
  312.    DOS.
  313.  
  314.    The Up and Down Arrow keys increase and decrease the user's time
  315.    respectively by 5 minutes for each press of the key. There is no
  316.    indication of what is occurring (except by the fact the user's
  317.    time remaining will change), so the sysop should try not to have
  318.    a lead finger. The increase or decrease is effective only while
  319.    the user is in RomBrain.
  320.  
  321.                                                                      7.
  322.  
  323.    This version of RomBrain is a DEMO. It will become full featured
  324.    upon registration. This door is released "As Is" and 
  325.    there is *NO* warranty or guarantee that it will work for you and 
  326.    not cause any problems. You have chosen to use this door, YOU are 
  327.    responsible for any unfortunate problems that may develop from its 
  328.    use or misuse. I will gladly listen to any suggestions or 
  329.    problems you may have, and I will do my best to fix whatever 
  330.    needs to be fixed. I can not be held responsible for any problems 
  331.    you may have, whether directly or indirectly due to the use of the
  332.    door or its utilities or associated files.
  333.    
  334.    Please read REGISTER.DOC for information on how you can register
  335.    your copy of RomBrain. The download option will only work on
  336.    a registered version.
  337.  
  338.    For complete support, contact PROFESSOR BRAINEX on The Brainex System.
  339.    Your questions will be quickly and cheerfully answered!
  340.  
  341.  
  342.    Have Fun!
  343.    Stanley Sheff
  344.    The Brainex System
  345.    310-275-2344 HST
  346.    310-273-5234 MNP
  347.  
  348.